Frontend Utility Functions

This document provides an overview of reusable frontend helper functions available in the codebase. These functions are grouped by their area of functionality.

---

clientStorage Client Functions

Function Name	Description
setSegment	Sets the current segment value in storage.
getSegment	Gets the current segment value from storage.
startImpersonation	Starts impersonation mode.
getImpersonateStorageKey	Gets the storage key for impersonation.
stopImpersonation	Stops impersonation mode.
isImpersonating	Checks if impersonation mode is active.
setAppViewStorageSettings	Sets app view storage settings for a given path.
getAppViewStorageSettings	Gets app view storage settings for a given path.
setHiddenAlerts	Sets hidden alerts for an app.
getHiddenAlerts	Gets hidden alerts for an app.
setAssetPageFilters	Sets asset page filters.
removeAssetPageFilters	Removes asset page filters.
getAssetPageFilters	Gets asset page filters.
setFeedInputRigId	Sets the feed input rig ID.
removeFeedInputRigId	Removes the feed input rig ID.
getFeedInputRigId	Gets the feed input rig ID.
getFeatureFlagAppsIsolation	Gets the feature flag for apps isolation.
FEATURE_FLAG_APPS_ISOLATION	Constant key for the feature flag apps isolation.

---

sso Client Functions

Function Name	Description
getSSOProvider	Returns the SSO provider object for the given platform (e.g., Auth0 or OAuth2).
isSSOPlatformSupported	Checks if the given platform is supported for SSO.

---

jsonApi Client Functions

Function Name	Description
getCurrentUser	Returns the current user information.
getWellViewBha	Fetches WellView BHA data.
getWells	Fetches a list of wells.
getWell	Fetches details for a specific well.
getRig	Fetches details for a specific rig.
patchRig	Updates a rig with new data.
getRigs	Fetches a list of rigs.
getPrograms	Fetches a list of programs.
getAsset	Fetches details for a specific asset.
getAssets	Fetches a list of assets.
getResolvedAssets	Fetches resolved asset data.
getPads	Fetches a list of pads.
getFracFleets	Fetches a list of frac fleets.
getDrilloutUnit	Fetches details for a specific drillout unit.
getDrilloutUnits	Fetches a list of drillout units.
deleteAppStorageRecords	Deletes multiple app storage records.
deleteAppStorage	Deletes a specific app storage record.
getAppStorage	Fetches app storage data for a provider, collection, and asset.
getDataAppStorage	Fetches app storage data for a provider and collection.
getDataAppStorageAggregate	Fetches aggregated app storage data.
putAppStorage	Updates or creates an app storage record.
putDataAppStorage	Updates or creates a data app storage record.
postAppStorage	Creates a new app storage record.
postDataAppStorage	Creates a new data app storage record.
getCompetitorAnalysisData	Fetches competitor analysis data.
getCompanies	Fetches a list of companies.
getPicklist	Fetches a picklist by name.
getFavorites	Fetches user favorites.
getCompanyGoals	Fetches goals for a specific company.
mapAssetGetRequest	Returns a function to fetch assets by type.
mapAssetByIdGetRequest	Returns a function to fetch an asset by ID and type.
postAnnotation	Creates a new annotation.
patchAnnotation	Updates an annotation.
deleteAnnotation	Deletes an annotation.
getAnnotations	Fetches annotations for a dashboard and asset.
getDashboardLastAnnotations	Fetches the last annotations for a dashboard and asset.
closeLastAnnotation	Closes the last annotation.
postAnnotationComment	Adds a comment to an annotation.
getAnnotationComments	Fetches comments for an annotation.
getFileDownloadLink	Returns a download link for a file.
patchFeedItemComment	Updates a comment on a feed item.
postFeedItemComment	Adds a comment to a feed item.
deleteFeedItemComment	Deletes a comment from a feed item.
toggleFeedItemLike	Toggles like status for a feed item.
patchFeedItem	Updates a feed item.
deleteFeedItem	Deletes a feed item.
getUserAutocomplete	Fetches user autocomplete suggestions.
getS3SignedUrl	Returns a signed S3 upload URL.
getS3DownloadLink	Returns a signed S3 download link.
getFracFleetWells	Fetches wells for a frac fleet.
getPadWells	Fetches wells for a pad.
getTask	Fetches a task by ID.
postTask	Creates a new task.
setCurrentUserSettings	Sets user settings.
getUserSetting	Fetches a specific user setting.
logout	Logs out the current user.
getPermissionCheck	Checks user permissions.
getDashboards	Fetches dashboards.
loginWithAuth0Token	Logs in using an Auth0 token.
getUserAuthSchemas	Fetches user authentication schemas.
getUserAuthPlatform	Fetches user authentication platform info.
postUserAuthTokenExchange	Exchanges a code for a user auth token.
getLASFileList	Fetches a list of LAS files for an asset.
getLASMetadata	Fetches metadata for a LAS file.
getLASFileDataByPage	Fetches LAS file data by page.
getAllLASFileData	Fetches all LAS file data for an asset and file.
getStreams	Fetches app streams for an asset.
getAppMedia	Fetches app media for an app.
deleteAppMedia	Deletes app media.
uploadAppMedia	Uploads app media.
updateAppMedia	Updates app media fields.
getAppHelpContent	Fetches app help content.
deleteAppHelpContent	Deletes app help content.
uploadAppHelpContent	Uploads app help content.
updateAppHelpContent	Updates app help content.
getAppPackages	Fetches app packages.
getAppSettingsTemplates	Fetches app settings templates.
getAppSettingsTemplate	Fetches a specific app settings template.
patchAppSettingsTemplate	Updates an app settings template.
postAppSettingsTemplate	Creates a new app settings template.
deleteAppSettingsTemplate	Deletes an app settings template.
shareAppSettingsTemplate	Shares an app settings template with users.
getUsersWithHeaders	Fetches users with headers.
getUsers	Fetches a list of users.